/*
 * MIT License
 *
 * Copyright (c) 2020 wen.gu <454727014@qq.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

/***************************************************************************
 * Name: instance_specifier.h
 *
 * Purpose: This section defines the ara::core::InstanceSpecifier type that 
 *          describes the path to a meta model element
 *
 * Developer:
 *   wen.gu , 2020-04-20
 *
 * TODO:
 *
 ***************************************************************************/

#ifndef __ARA_CORE_INSTANCE_SPECIFIER_H__
#define __ARA_CORE_INSTANCE_SPECIFIER_H__
/******************************************************************************
 **    INCLUDES
 ******************************************************************************/

#include "ara/core/string_view.h"
#include "ara/core/result.h"
#include "ara/core/string.h"

/******************************************************************************
 **    MACROS
 ******************************************************************************/


/******************************************************************************
 **    TYPE DEFINITIONS
 ******************************************************************************/
namespace ara
{
namespace core
{
/******************************************************************************
 **    CLASSES/FUNCTIONS DEFINITIONS
 ******************************************************************************/
class InstanceSpecifier final 
{
public:
    explicit InstanceSpecifier(StringView metaModelIdentifier)
        :mInstStr(metaModelIdentifier)
    {
        /** tod something */
    }
    ~InstanceSpecifier() noexcept
    {
        /** tod something */
    }

public:
    static Result<InstanceSpecifier> Create(StringView metaModelIdentifier)
    {
        return Result<InstanceSpecifier>(InstanceSpecifier(metaModelIdentifier));
    }

public:
    bool operator== (InstanceSpecifier const& other) const noexcept
    {
        return mInstStr == other.mInstStr;
    }

    bool operator== (StringView other) const noexcept
    {
        return mInstStr.compare(other) == 0;
    }

    bool operator!= (InstanceSpecifier const& other) const noexcept
    {
        return mInstStr != other.mInstStr;
    }

    bool operator!= (StringView other) const noexcept
    {
        return mInstStr.compare(other) != 0;
    }

    bool operator< (InstanceSpecifier const& other) const noexcept
    {
        return mInstStr < other.mInstStr;
    }

public:
    StringView ToString() const noexcept
    {
        return { mInstStr.c_str(), mInstStr.size() };
    }

private:
    String mInstStr;
};

} /** namespace core */
} /** namespace ara */

#endif /** !__ARA_CORE_INSTANCE_SPECIFIER_H__ */

